<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
    <title>Reference</title>
    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>

<div id="container">

<div id="product">
	<div id="product_logo"></div>
	<div id="product_name"><big><b></b></big></div>
	<div id="product_description"></div>
</div> <!-- id="product" -->


<div id="main">


<!-- Menu -->

<div id="navigation">
<br/>
<h1>luamqtt</h1>

<ul>
  <li><a href="../index.html">Index</a></li>
</ul>

<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
<li><a href="#Tables">Tables</a></li>
</ul>


<h2>Modules</h2>
<ul class="nowrap">
  <li><strong>mqtt</strong></li>
  <li><a href="../modules/mqtt.client.html">mqtt.client</a></li>
  <li><a href="../modules/mqtt.ioloop.html">mqtt.ioloop</a></li>
</ul>
<h2>Topics</h2>
<ul class="">
  <li><a href="https://github.com/xHasKx/luamqtt#readme">README</a></li>
  <li><a href="../topics/LICENSE.html">LICENSE</a></li>
</ul>
<h2>Examples</h2>
<ul class="nowrap">
  <li><a href="../examples/simple.lua.html">simple.lua</a></li>
  <li><a href="../examples/sync.lua.html">sync.lua</a></li>
  <li><a href="../examples/mqtt5-simple.lua.html">mqtt5-simple.lua</a></li>
</ul>

</div>

<div id="content">

<h1>Module <code>mqtt</code></h1>
<p>MQTT module</p>
<p></p>


<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#client">client (...)</a></td>
	<td class="summary">Create new MQTT client instance</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#get_ioloop">get_ioloop ()</a></td>
	<td class="summary">Returns default ioloop instance</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#run_ioloop">run_ioloop (...)</a></td>
	<td class="summary">Run default ioloop for given MQTT clients or functions</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#run_sync">run_sync (cl)</a></td>
	<td class="summary">Run synchronous input/output loop for only one given MQTT client.</td>
	</tr>
</table>
<h2><a href="#Tables">Tables</a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#mqtt">mqtt</a></td>
	<td class="summary">Module table</td>
	</tr>
</table>

<br/>
<br/>


    <h2 class="section-header "><a name="Functions"></a>Functions</h2>

    <dl class="function">
    <dt>
    <a name = "client"></a>
    <strong>client (...)</strong>
    </dt>
    <dd>
    Create new MQTT client instance


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">...</span>
         Same as for mqtt.client.create(...)
        </li>
    </ul>



    <h3>See also:</h3>
    <ul>
         <a href="../modules/mqtt.client.html#client_mt:__init">__init</a>
    </ul>


</dd>
    <dt>
    <a name = "get_ioloop"></a>
    <strong>get_ioloop ()</strong>
    </dt>
    <dd>
    Returns default ioloop instance







</dd>
    <dt>
    <a name = "run_ioloop"></a>
    <strong>run_ioloop (...)</strong>
    </dt>
    <dd>
    Run default ioloop for given MQTT clients or functions


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">...</span>
         MQTT clients or lopp functions to add to ioloop
        </li>
    </ul>



    <h3>See also:</h3>
    <ul>
         <li><a href="../modules/mqtt.ioloop.html#ioloop_mt:get">mqtt.ioloop.get</a></li>
         <li><a href="../modules/mqtt.ioloop.html#ioloop_mt:run_until_clients">mqtt.ioloop.run_until_clients</a></li>
    </ul>


</dd>
    <dt>
    <a name = "run_sync"></a>
    <strong>run_sync (cl)</strong>
    </dt>
    <dd>
    Run synchronous input/output loop for only one given MQTT client.
 Provided client's connection will be opened.
 Client reconnect feature will not work, and keep_alive too.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">cl</span>
         MQTT client instance to run
        </li>
    </ul>





</dd>
</dl>
    <h2 class="section-header "><a name="Tables"></a>Tables</h2>

    <dl class="function">
    <dt>
    <a name = "mqtt"></a>
    <strong>mqtt</strong>
    </dt>
    <dd>
    Module table


    <h3>Fields:</h3>
    <ul>
        <li><span class="parameter">v311</span>
         MQTT v3.1.1 protocol version constant
        </li>
        <li><span class="parameter">v50</span>
          MQTT v5.0   protocol version constant
        </li>
        <li><span class="parameter">_VERSION</span>
         luamqtt version string
        </li>
    </ul>





</dd>
</dl>


</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2020-07-09 23:06:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
